/*
 * @Author: Jae Frank[thissfk@qq.com]
 * @Date: 2024-02
 * @LastEditors: Jae Frank[thissfk@qq.com]
 * @LastEditTime: 2024-04
 * @FilePath: zf_driver_soft_iic.h
 * @Description:
 *            If you need more information,
 * please contact Jae Frank[thissfk@qq.com] to get an access.
 * Copyright (c) 2024 by Jae Frank, All Rights Reserved.
 */
/*********************************************************************************************************************
 * CYT4BB Opensourec Library 即（ CYT4BB 开源库）是一个基于官方 SDK
 *接口的第三方开源库 Copyright (c) 2022 SEEKFREE 逐飞科技
 *
 * 本文件是 CYT4BB 开源库的一部分
 *
 * CYT4BB 开源库 是免费软件
 * 您可以根据自由软件基金会发布的 GPL（GNU General Public License，即
 *GNU通用公共许可证）的条款 即 GPL 的第3版（即
 *GPL3.0）或（您选择的）任何后来的版本，重新发布和/或修改它
 *
 * 本开源库的发布是希望它能发挥作用，但并未对其作任何的保证
 * 甚至没有隐含的适销性或适合特定用途的保证
 * 更多细节请参见 GPL
 *
 * 您应该在收到本开源库的同时收到一份 GPL 的副本
 * 如果没有，请参阅<https://www.gnu.org/licenses/>
 *
 * 额外注明：
 * 本开源库使用 GPL3.0 开源许可证协议 以上许可申明为译文版本
 * 许可申明英文版在 libraries/doc 文件夹下的 GPL3_permission_statement.txt
 *文件中 许可证副本在 libraries 文件夹下 即该文件夹下的 LICENSE 文件
 * 欢迎各位使用并传播本程序 但修改内容时必须保留逐飞科技的版权声明（即本声明）
 *
 * 文件名称          zf_driver_soft_iic
 * 公司名称          成都逐飞科技有限公司
 * 版本信息          查看 libraries/doc 文件夹内 version 文件 版本说明
 * 开发环境          IAR 9.40.1
 * 适用平台          CYT4BB
 * 店铺链接          https://seekfree.taobao.com/
 *
 * 修改记录
 * 日期              作者                备注
 * 2024-1-8       pudding            first version
 ********************************************************************************************************************/

#ifndef _zf_driver_soft_iic_h_
#define _zf_driver_soft_iic_h_

#include "zf_common_typedef.h"
#include "zf_driver_gpio.h"

typedef struct {
  uint32 scl_pin; // 用于记录对应的引脚编号
  uint32 sda_pin; // 用于记录对应的引脚编号
  uint8 addr;     // 器件地址 七位地址模式
  uint32 delay;   // 模拟 IIC 软延时时长
} soft_iic_info_struct;

//==================================================SOFT_IIC
// 基础函数====================================================
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
void soft_iic_write_8bit(soft_iic_info_struct *soft_iic_obj, const uint8 data);
void soft_iic_write_8bit_array(soft_iic_info_struct *soft_iic_obj,
                               const uint8 *data, uint32 len);

void soft_iic_write_16bit(soft_iic_info_struct *soft_iic_obj,
                          const uint16 data);
void soft_iic_write_16bit_array(soft_iic_info_struct *soft_iic_obj,
                                const uint16 *data, uint32 len);

void soft_iic_write_8bit_register(soft_iic_info_struct *soft_iic_obj,
                                  const uint8 register_name, const uint8 data);
uint8_t soft_iic_write_8bit_registers(soft_iic_info_struct *soft_iic_obj,
                                      const uint8 register_name,
                                      const uint8 *data, uint32 len);

void soft_iic_write_16bit_register(soft_iic_info_struct *soft_iic_obj,
                                   const uint16 register_name,
                                   const uint16 data);
void soft_iic_write_16bit_registers(soft_iic_info_struct *soft_iic_obj,
                                    const uint16 register_name,
                                    const uint16 *data, uint32 len);

uint8 soft_iic_read_8bit(soft_iic_info_struct *soft_iic_obj);
void soft_iic_read_8bit_array(soft_iic_info_struct *soft_iic_obj, uint8 *data,
                              uint32 len);

uint16 soft_iic_read_16bit(soft_iic_info_struct *soft_iic_obj);
void soft_iic_read_16bit_array(soft_iic_info_struct *soft_iic_obj, uint16 *data,
                               uint32 len);

uint8 soft_iic_read_8bit_register(soft_iic_info_struct *soft_iic_obj,
                                  const uint8 register_name);
uint8_t soft_iic_read_8bit_registers(soft_iic_info_struct *soft_iic_obj,
                                     const uint8 register_name, uint8 *data,
                                     uint32 len);

uint16 soft_iic_read_16bit_register(soft_iic_info_struct *soft_iic_obj,
                                    const uint16 register_name);
void soft_iic_read_16bit_registers(soft_iic_info_struct *soft_iic_obj,
                                   const uint16 register_name, uint16 *data,
                                   uint32 len);

void soft_iic_transfer_8bit_array(soft_iic_info_struct *soft_iic_obj,
                                  const uint8 *write_data, uint32 write_len,
                                  uint8 *read_data, uint32 read_len);
void soft_iic_transfer_16bit_array(soft_iic_info_struct *soft_iic_obj,
                                   const uint16 *write_data, uint32 write_len,
                                   uint16 *read_data, uint32 read_len);

void soft_iic_sccb_write_register(soft_iic_info_struct *soft_iic_obj,
                                  const uint8 register_name, uint8 data);
uint8 soft_iic_sccb_read_register(soft_iic_info_struct *soft_iic_obj,
                                  const uint8 register_name);

void soft_iic_init(soft_iic_info_struct *soft_iic_obj, uint8 addr, uint32 delay,
                   gpio_pin_enum scl_pin, gpio_pin_enum sda_pin);
#ifdef __cplusplus
}
#endif // __cplusplus

//==================================================SOFT_IIC
// 基础函数====================================================

#endif
